home *** CD-ROM | disk | FTP | other *** search
/ Fritz: All Fritz / All Fritz.zip / All Fritz / FILES / COMMADIO / XRS3.LZH / XCS100.ZIP / ARCHIVE.ZIP / ARCHIVE.MAN < prev    next >
Text File  |  1991-05-05  |  21KB  |  415 lines
  1.          
  2.          
  3.          
  4.          
  5.          
  6.          
  7.          
  8.          
  9.          
  10.          
  11.          
  12.          
  13.          
  14.          
  15.          
  16.          
  17.          
  18.          
  19.          
  20.          
  21.          
  22.          
  23.          
  24.                           XXX    XXX      CCCCCCCC       SSSSSSSS
  25.                           XXX  XXX      CCC    CCC     SSS    SSS
  26.                           XXXXXX       CCC            SSS
  27.                           XXXX        CCC              SSSSSS
  28.                         XXXXXX       CCC                   SSS
  29.                       XXX  XXX      CCC    CCC     SSS    SSS
  30.                     XXX    XXX      CCCCCCCC       SSSSSSSS
  31.          
  32.                                    A R C H I V E
  33.          
  34.          
  35.          
  36.                       eXpress Conversion System version 1.00
  37.          
  38.          
  39.                (C) Copyright 1990-1991 by Rudi J.A. Kusters, ProCess
  40.          
  41.                  All rights reserved - Alle rechten voorbehouden.
  42.          
  43.          
  44.                       FidoNet Addresses: 2:512/34.4 (2:512/1)
  45.                          SIGnet Address: 27:3331/2206
  46.                    
  47.          eXpress Conversion System 1.00                           Page 0-1
  48.          
  49.          
  50.          ┌───────────────────────────────────────────────────────────────┐
  51.          │  Using XCS To Convert Archive Files                           │
  52.          └───────────────────────────────────────────────────────────────┘
  53.          
  54.          
  55.             One  of  the  finest  features  of  the eXpress Response System
  56.          (XRS) is the ability  to  archive  messages  you have read.  Up to
  57.          now you have probably seldom looked into the archive  file.   Have
  58.          you  ever  tried  to  reply  to an archived message?  Lot of work,
  59.          wasn't it? That's why I started the eXpress Conversion System.
  60.          
  61.             With  XCS  you  can  convert  the  archived  messages  into   a
  62.          XRS-compatible  mailbag.  After  conversion  you  can  re-use  the
  63.          archived messages just like any  other  mailbag. Using XRS you can
  64.          re-Read them, Reply to them, Quote them,  Print  them,  or  Tag  &
  65.          archive  them  again  to  get an archive of e.g. messages with the
  66.          same subject.  This new archive  file  can once again be converted
  67.          by XCS into XRS format.
  68.          
  69.          
  70.          ┌───────────────────────────────────────────────────────────────┐
  71.          │  Contents                                                     │
  72.          └───────────────────────────────────────────────────────────────┘
  73.          
  74.          
  75.          ∙  Configuration Parameters  . . . . . . . . . . . . . . . . 0-1
  76.          ∙  Command Line Syntax . . . . . . . . . . . . . . . . . . . 0-1
  77.          ∙  Maintaining The Archive File  . . . . . . . . . . . . . . 0-6
  78.          
  79.          
  80.          ┌───────────────────────────────────────────────────────────────┐
  81.          │  Configuration Parameters                                     │
  82.          └───────────────────────────────────────────────────────────────┘
  83.          
  84.          
  85.             At  this  time,  only  the XCS_Limit parameter is read from the
  86.          CONFIG.XCS or CONFIG.XRS file.
  87.          
  88.          
  89.          ┌───────────────────────────────────────────────────────────────┐
  90.          │  Command Line Syntax                                          │
  91.          └───────────────────────────────────────────────────────────────┘
  92.          
  93.          
  94.             To convert an archive file, type the following command  at  the
  95.          DOS prompt:
  96.          
  97.             [drive:\directory\]XCS /cArchive | /c0 [/a] [/f<flags>]
  98.                                    [/l<limit>] [/n<node>] [/o<order>]
  99.                                    [/s<source>]
  100.                    
  101.          eXpress Conversion System 1.00                           Page 0-2
  102.          
  103.          
  104.             If you have the XCS  program  files  on  you DOS PATH or in the
  105.          current directory, you don't need to specify drive and  directory.
  106.          If not, specify them as indicated, e.g. 'C:\XRS\XCS'. The file
  107.          
  108.          ARCHIVE.EXE  *MUST*  be  in the very same directory as the XCS.EXE
  109.          program.  Otherwise, it won't run!
  110.          
  111.             A lot of parameters, but  all  of them (except /c) are optional
  112.          and the order doesn't  matter,  nor  does  the  case.   You  must,
  113.          however,  separate  arguments with a space.  Here's an explanation
  114.          of what they do:
  115.          
  116.          
  117.          /cArchive     Type of conversion
  118.                        This is  how  you  tell  XCS  that  you  want  it to
  119.                        convert a XRS archive alike file to a  XRS  mailbag.
  120.                        You may also use '/c0'.
  121.          
  122.          /c0           Specifying  '/c0'  is   the   same   as   specifying
  123.                        '/cArchive'.
  124.          
  125.          
  126.          /a            Append to an existing mailfile
  127.                        If you want to  append  the converted messages to an
  128.                        existing  mailfile,   you   can   specify   the   /a
  129.                        parameter.    You   can  use  this  to  convert  the
  130.                        messages of  more  than  one  archive  file into the
  131.                        same  XRS  mailfile,  or  to  append   the   archive
  132.                        messages  to  a  regular  mailfile you received from
  133.                        the BBS. The first message  to be converted will get
  134.                        the number of the existing messages plus one.   This
  135.                        could  be  a  lower  number  than  that  of the last
  136.                        existing message, but this  will  not lead to severe
  137.                        problems.
  138.          
  139.             Default:   The  default  is  *not* to append, but to create new
  140.                        files.   Any   existing    file    with   the   name
  141.                        BAT?MAIL.XRS, MAIL?IDX.XRS, or SUMMARY?.XRS will  be
  142.                        overwritten.    The   question  mark  '?'  in  these
  143.                        filenames is  the  node/line  number  specified with
  144.                        /n<node>.
  145.                    
  146.          eXpress Conversion System 1.00                           Page 0-3
  147.          
  148.          
  149.          /fNone        Sets none of the flags    (same as /f0)
  150.          /fRead        Mark all messages 'Read'  (same as /f1)
  151.                        With  '/fRead'  or  '/f1'  you  tell  XRS  that  you
  152.                        already  have  read all messages in the mailbag.  If
  153.                        you have  read  a  mailbag  (regular  BBS mailbag or
  154.                        mailbag converted by XCS), but want to go  thru  the
  155.                        lot  again, you can use the 'ReRead' conversion type
  156.                        (and _not_ '/fNone'!) to remove those marks.
  157.          
  158.             Default:   No messages read ('/fNone' or '/f0')
  159.          
  160.          
  161.          /l<limit>     Maximum number of messages to be converted
  162.                        XCS  will  convert no more than the number specified
  163.                        with 'XCS_Limit' in  CONFIG.X?S.   You can overwrite
  164.                        this number for this session only with  the  command
  165.                        line  parameter  'l<limit>'.   Any  number between 0
  166.                        and 65535 is valid.  Sorting however, is limited  to
  167.                        1200 messages.
  168.          
  169.             Default:   Mailbag size is limited to 65535 messages.
  170.          
  171.          
  172.          /n<node>      Node or line number
  173.                        With  this  parameter  you  can specify the node (or
  174.                        line) number (1-9 or A-Z)  to use for the mailfiles.
  175.                        See your  XRS  documentation  for  more  information
  176.                        about   these   numbers.    If  you  have  the  file
  177.                        AREAS3.XRS and USER3.XRS,  you  can specify '/n3' to
  178.                        create (or append to)  the  mailfiles  BAT3MAIL.XRS,
  179.                        MAIL3IDX.XRS AND SUMMARY3.XRS.
  180.          
  181.             Default:   By default node number 1  will be used. In this case
  182.                        you need the files AREAS1.XRS  and  USER1.XRS.   The
  183.                        created  files  are  BAT1MAIL.XRS,  MAIL1IDX.XRS and
  184.                        SUMMARY1.XRS.  If you  have  specified '/a /n1', but
  185.                        you  have  only  the  mailfiles  for  node  2,   the
  186.                        converted  messages  will *not* be appended to these
  187.                        files. Instead, new  mailfiles  are created for node
  188.                        1.
  189.                    
  190.          eXpress Conversion System 1.00                           Page 0-4
  191.          
  192.          
  193.          /oNone        Don't sort message              (same as /o0)
  194.          /oDate        Sort messages by date and time  (same as /o1)
  195.          /oName        Sort messages by name of writer (same as /o2)
  196.          /oSubject     Sort messages by subject        (same as /o3)
  197.          /oArea        Sort messages by echomail area  (same as /o4)
  198.          
  199.                        This way you tell  XCS  how  to sort the messages or
  200.                        not to sort them at all. If you choose to  sort  the
  201.                        messages,  XCS  will  first scan the archive file to
  202.                        build  a  table,  then  sort  this  table  and  next
  203.                        convert  the  messages   in   sorted   order.   When
  204.                        appending  to  an  existing  mailbag,  sorting  only
  205.                        applies  to  the  messages  that  are  ADDED  to the
  206.                        mailbag.  At this time, sorting is limited  to  1200
  207.                        messages.
  208.                        
  209.                        Something  to  experiment  with:  when  you sort the
  210.                        archive by  echomail  area  ('/oArea'  or '/o4') and
  211.                        'Read  Messages  Chronologically'  in  XRS  you  can
  212.                        decrease  disk  movements  significantly.  Since the
  213.                        messages are  already  sorted,  XRS  doesn't need to
  214.                        travel thru the mailbag as much as it would have  if
  215.                        the mail was not sorted.
  216.          
  217.             Default:   By  default  the messages are NOT sorted, but stored
  218.                        in the mailbag  in  exactly  the  same order as they
  219.                        appear in the archive file.
  220.          
  221.          
  222.          /s<source>    Name of the archive file
  223.                        You can use this parameter to specify  the  name  of
  224.                        the   file   that   contains   the  messages  to  be
  225.                        converted.  This  name  can  include  a drive and/or
  226.                        directory specification.  The  name  of  the  source
  227.                        file  including  drive  and directory may not exceed
  228.                        80 characters.
  229.          
  230.             Default:   The default  name  of  the  file  that  contains the
  231.                        messages to be  converted  is  ARCHIVED.XRS  in  the
  232.                        current  directory.   If XCS can't find this file in
  233.                        the current directory, it  is  not going to look for
  234.                        it elsewhere.
  235.          
  236.          
  237.          Examples:     XCS /c0
  238.          
  239.                        XCS converts the file ARCHIVED.XRS (which is in  the
  240.                        current   directory),   uses   the   existing  files
  241.                        USER1.XRS  and  AREAS1.XRS  and  creates  the  files
  242.                        BAT1MAIL.XRS,   MAIL1IDX.XRS,    SUMMARY1.XRS    and
  243.                        BAG_ID.XRS in the current directory.
  244.          
  245.                    
  246.          eXpress Conversion System 1.00                           Page 0-5
  247.          
  248.          
  249.                        XCS /a /cArchive /s\XRS\STORED.XRS /n4 /o3
  250.          
  251.                        In  this  case  XCS looks for the file STORED.XRS in
  252.                        the \XRS  directory,  uses  the  files USER4.XRS and
  253.                        AREAS4.XRS in the current directory and appends  the
  254.                        converted    messages    to   the   existing   files
  255.                        BAT4MAIL.XRS,    MAIL4IDX.XRS,    SUMMARY4.XRS   and
  256.                        BAG_ID.XRS. The messages are sorted by subject.
  257.          
  258.          
  259.             After starting XCS the screen shows the XCS  logo.  The  bottom
  260.          line  shows  (from  left  to  right)  the  chosen  conversion type
  261.          ('Archive'  in  this  case),  the  chosen  options  (Node, Append,
  262.          Flags, Sort) and the name of the source file. The box  just  below
  263.          the  middle  of the screen informs you on the conversion progress.
  264.          The messages are:
  265.          
  266.                        ┌────────────────────────────────────────────────
  267.                        │ Creating mailbag for: <your name>
  268.                        │ Send any replies to node: <your boss's node>
  269.                        │ Number of messages found: <nnn>
  270.                        │ Sorting Message Table...
  271.          
  272.             The  last  two of these you will only see if you have chosen to
  273.          sort the messages.  At the  time the actual conversion is started,
  274.          you'll see:
  275.          
  276.                        │ Converting source file to Bat1Mail.Xrs...
  277.                        │ Working on message      : <nnn> (<yyy> to you!)
  278.          
  279.          where 'nnn' is the  current  treated  message number and 'yyy' the
  280.          number of messages addressed to you.
  281.          
  282.          
  283.             XCS   searches   for   the   first   line   that   starts  with
  284.          "      To:  ". If any  of  the  lines  in  the message body starts
  285.          with the same string, it will be treated as the  start  of  a  new
  286.          message!  Use  a  texteditor  to change the misinterpreted line if
  287.          this happens. Following the  first  line,  the other three message
  288.          header lines must exist.  XCS stops converting if one of  them  is
  289.          not found. All following lines are considered to be  message  text
  290.          up  to  the  next  line  starting  with  the  "To:" string, or the
  291.          occurance of  the  line  that  starts  with  "=-=-=-=-=".   If the
  292.          latter of these is found, lines between  this  one  and  the  next
  293.          "To:"  line  are  skipped.  The source file is read as a textfile,
  294.          meaning that an EOF is an  end  of  file  and if it's found in the
  295.          middle of the source file, the rest is ignored.  Delete these  out
  296.          of place EOF's with an editor and restart conversion.
  297.          
  298.             Any   existing   files   with   the   name   BAT<node>MAIL.XRS,
  299.          SUMMARY<node>.XRS or MAIL<node>IDX.XRS will be overwritten  unless
  300.          you   have  specified  the  '/a'  parameter,  in  which  case  the
  301.          converted messages are appended to those files.
  302.                    
  303.          eXpress Conversion System 1.00                           Page 0-6
  304.          
  305.          
  306.             Now you can  start  RESPONSE  to  work  on  the  newly  created
  307.          archive mailbag.
  308.          
  309.          
  310.          ┌───────────────────────────────────────────────────────────────┐
  311.          │  Maintaining The Archive File                                 │
  312.          └───────────────────────────────────────────────────────────────┘
  313.          
  314.          
  315.             To make sure  you  don't  send  replies  in  areas  that do not
  316.          longer exist, or reply to a message that came from  another  board
  317.          than  the  Areas?.Xrs  file,  XCS  checks the area (group) tag and
  318.          number in the  message  header  lines.   If  the  name is found in
  319.          Areas?.Xrs but with another  number,  the  correct  areanumber  is
  320.          substituted  in  the  header line.  If the areatag is not found in
  321.          Areas?.Xrs, the group  info  is  changed  to  'LOCAL (0)', meaning
  322.          that the message is moved to the local area.
  323.          
  324.             That's  all  I  can  do  to prevent messages going in the wrong
  325.          echo.  You only have to  keep  a  recent copy of Areas?.Xrs in the
  326.          directory where you start the conversion!
  327.          
  328.             Things still could grow into a total  mess,  if  you  don't  do
  329.          some  regular  maintainance  work.   There  are several ways to do
  330.          this.  Here are some examples.
  331.          
  332.          
  333.          ■  Adding To The Archive File ___________________________________
  334.          
  335.             XCS does not only convert the ARCHIVED.XRS  file  (or  whatever
  336.          name  you  gave the archive file), but digests any other XRS alike
  337.          message file as well.  For instance, you can  eXport  the  message
  338.          you  have  read  and eXport your reply to it. Afterwards you enter
  339.          the DOS command:
  340.          
  341.             COPY CONTACT.XRS+HIS.MSG+MYREPLY.MSG CONTACT.XRS/B
  342.                                                            ^^^^
  343.          
  344.          (or  something similar) to append them to an archive file.  In the
  345.          same way you can  combine  two  separate  archive files before you
  346.          pass them on to XCS. Note the "/B" at the end of the target  file.
  347.          This  is *not* optional!  XCS stops reading at the first occurence
  348.          of an "end of file"  character  (^Z, 26 decimal, 1A hex). Although
  349.          XRS doesn't put them in (and never  has  done),  some  texteditors
  350.          and  the  DOS  copy command might.  Use a texteditor to delete all
  351.          ^Z characters from the  archive  file  _before_  you run XCS.  See
  352.          your DOS manual for more information on the end of file  character
  353.          and the DOS COPY command parameter /B.
  354.          
  355.             You  can  even turn any ASCII file into a XRS readable message.
  356.          The only thing you need to do  is to start the ASCII file with the
  357.          proper message header lines.  For this purpose I have  enclosed  a
  358.          file containing these lines.
  359.                    
  360.          eXpress Conversion System 1.00                           Page 0-7
  361.          
  362.          
  363.          Use the DOS command:
  364.          
  365.             COPY HEADER.XCS+ASCII.TXT MESSAGE.TXT/B
  366.          
  367.          (substituting  your  own  filenames) to add the headerlines to the
  368.          top of your ASCII file or use  your  texteditor  and  import  this
  369.          header  file  at  the very top of your text.  Lines longer than 79
  370.          characters are wrapped by XCS.   You  can  make your lines as long
  371.          as 2045 characters and  XCS  will  format  them.  'Soft'  carriage
  372.          returns are _not_ replaced.
  373.          
  374.             In the header  lines  you  must  replace  some  fields with the
  375.          necessary  info.  Each  series  of  'aaa'  can  be   replaced   by
  376.          alphanumeric  characters,  each  series  of 'nnn' by numbers only.
  377.          Take a close look at  the  headers  of the XRS messages and you'll
  378.          know what to do.  Don't alter  the  positions  of  the  fields  or
  379.          their  labels.   XCS  will  instantly  stop  converting before XRS
  380.          looses control while displaying them.
  381.          
  382.             You  _must_  provide the information in the 'Date' field, since
  383.          XCS can sort  the  messages  by  date.   Enter  the areatag in the
  384.          'Group' field - you don't need to enter the areanumber,  XCS  will
  385.          automagically find the right one.
  386.          
  387.             You  can  not   add   messages   to   the   converted   mailbag
  388.          (BAT?MAIL.XRS)  manually.   You  can  however  add messages to the
  389.          archive file and use XCS to  reconvert, or make a separate archive
  390.          file and let XCS append them to the XRS mail files.
  391.          
  392.          
  393.          ■  Selecting Messages To Make A New Archive _____________________
  394.          
  395.             When the archive mailbag gets too big,  you  could  split  them
  396.          into  multiple archives.  Maybe you want all messages related to a
  397.          certain subject in a  separated  file.   All  this  can be done by
  398.          XRS.  Start the program, TAG the messages that  you  want  in  the
  399.          new  file  and enter the name of the new archive file when leaving
  400.          XRS.  You  can  also  use  the  XRS  AutoTAG  parameters  to do an
  401.          automatic selection.
  402.          
  403.          
  404.          ■  Deleting Messages ____________________________________________
  405.          
  406.             For the moment you have to use some tricks  to  delete  one  or
  407.          more  messages.  You could use your texteditor to delete a message
  408.          from the archive file (NOT FROM  THE MAILBAG).  An other way is to
  409.          TAG *all* messages, using the  (3.11  and  up)  parameter  AutoTag
  410.          and/or  AutoMatch  to  mark all messages containing two characters
  411.          that are in all  messages.   Then  UNTAG  the messages you want to
  412.          delete and save the rest to a new archive file when leaving XRS.
  413.          
  414.          ---
  415.